SftTree/NET 2.0

NavigateUp Method, SftTree Class

Softel vdm, Inc.

Navigates up one item or cell from the specified item or cell.

Syntax      SftTree Class (Softelvdm.SftTreeNET)

VB   

Public Function NavigateUp( _
     ByVal StartObject As Object, _
     ByVal fSelect As Boolean, _
     ByVal fSelectCumulative As Boolean _
  ) As Object

C#   

public object NavigateUp(
     object StartObject,
     bool fSelect,
     bool fSelectCumulative );

C++   

public: Object^ NavigateUp(
     Object^ StartObject,
     bool fSelect,
     bool fSelectCumulative );

fSelect

Defines whether the item or cell found is automatically selected, True to select, otherwise False.

fSelectCumulative

Defines whether the selection is cumulative. True if the selection is cumulative, otherwise False. This parameter is ignored if fSelect is False and can only be used with when multiple item or multiple cell selection is active (SelectionStyle).

StartObject

Defines the starting item (ItemClass) or cell (CellClass). If null/Nothing is specified, the focus object (FocusObject) is the starting item or cell.

Return Value

The item or cell.

Comments

The NavigateUp method navigates up one item or cell from the specified item or cell.

Given a starting item or cell, this method returns the next item or cell in that direction that can be selected. It considers cell merging and the selectable area (SelectableArea).

If fSelect is True to automatically select the new item or cell, the specified StartObject, an item or cell, must match the current selection style (SelectionStyle).

If the StartObject parameter is null/Nothing and the FocusObject property is null/Nothing, the method returns null/Nothing.


Feedback / comments / error reports for this topic
© 2007 - Softel vdm, Inc. - www.softelvdm.com